home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / JFC.bin / JCheckBox.java < prev    next >
Text File  |  1998-06-30  |  7KB  |  204 lines
  1. /*
  2.  * @(#)JCheckBox.java    1.36 98/02/16
  3.  * 
  4.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not disclose
  8.  * such Confidential Information and shall use it only in accordance with the
  9.  * terms of the license agreement you entered into with Sun.
  10.  * 
  11.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  12.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  13.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
  14.  * OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
  15.  * LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR
  16.  * ITS DERIVATIVES.
  17.  * 
  18.  */
  19. package com.sun.java.swing;
  20.  
  21. import java.awt.*;
  22. import java.awt.event.*;
  23. import com.sun.java.accessibility.*;
  24. import com.sun.java.swing.plaf.*;
  25.  
  26.  
  27. /**
  28.  * An implementation of a CheckBox -- an item that can be selected or
  29.  * deselected, and which displays its state to the user. In a group
  30.  * of checkboxes, multiple checkboxes can be selected. 
  31.  *
  32.  * See <a href="http://java.sun.com/docs/books/tutorial/ui/swing/checkbox.html">How to Use CheckBoxes</a>
  33.  * in <a href="http://java.sun.com/Series/Tutorial/index.html"><em>The Java Tutorial</em></a>
  34.  * for further documentation.
  35.  * <p>
  36.  * For the keyboard keys used by this component in the standard Look and
  37.  * Feel (L&F) renditions, see the
  38.  * <a href="doc-files/Key-Index.html#JCheckBox">JCheckBox</a> key assignments.
  39.  * <p>
  40.  * Warning: serialized objects of this class will not be compatible with
  41.  * future swing releases.  The current serialization support is appropriate 
  42.  * for short term storage or RMI between Swing1.0 applications.  It will
  43.  * not be possible to load serialized Swing1.0 objects with future releases
  44.  * of Swing.  The JDK1.2 release of Swing will be the compatibility
  45.  * baseline for the serialized form of Swing objects.
  46.  *
  47.  * @see JRadioButton
  48.  *
  49.  * @beaninfo
  50.  *   attribute: isContainer false
  51.  *
  52.  * @version 1.36 02/16/98
  53.  * @author Jeff Dinkins
  54.  */
  55. public class JCheckBox extends JToggleButton implements Accessible {
  56.  
  57.     /**
  58.      * Creates an initially unselected checkbox button with no text, no icon.
  59.      */
  60.     public JCheckBox () {
  61.         this(null, null, false);
  62.     }
  63.  
  64.     /**
  65.      * Creates an initially unselected checkbox with an icon.
  66.      *
  67.      * @param icon  the Icon image to display
  68.      */
  69.     public JCheckBox(Icon icon) {
  70.         this(null, icon, false);
  71.     }
  72.     
  73.     /**
  74.      * Creates a checkbox with an icon and specifies whether
  75.      * or not it is initially selected.
  76.      *
  77.      * @param icon  the Icon image to display
  78.      * @param selected a boolean value indicating the initial selection
  79.      *        state. If <code>true</code> the checkbox is selected
  80.      */
  81.     public JCheckBox(Icon icon, boolean selected) {
  82.         this(null, icon, selected);
  83.     }
  84.     
  85.     /**
  86.      * Creates an initially unselected checkbox with text.
  87.      *
  88.      * @param text the text of the checkbox.
  89.      */
  90.     public JCheckBox (String text) {
  91.         this(text, null, false);
  92.     }
  93.  
  94.     /**
  95.      * Creates a checkbox with text and specifies whether 
  96.      * or not it is initially selected.
  97.      *
  98.      * @param text the text of the checkbox.
  99.      * @param selected a boolean value indicating the initial selection
  100.      *        state. If <code>true</code> the checkbox is selected
  101.      */
  102.     public JCheckBox (String text, boolean selected) {
  103.         this(text, null, selected);
  104.     }
  105.  
  106.     /**
  107.      * Creates an initially unselected checkbox with 
  108.      * the specified text and icon.
  109.      *
  110.      * @param text the text of the checkbox.
  111.      * @param icon  the Icon image to display
  112.      */
  113.     public JCheckBox(String text, Icon icon) {
  114.         this(text, icon, false);
  115.     }
  116.  
  117.     /**
  118.      * Creates a checkbox with text and icon,
  119.      * and specifies whether or not it is initially selected.
  120.      *
  121.      * @param text the text of the checkbox.
  122.      * @param icon  the Icon image to display
  123.      * @param selected a boolean value indicating the initial selection
  124.      *        state. If <code>true</code> the checkbox is selected
  125.      */
  126.     public JCheckBox (String text, Icon icon, boolean selected) {
  127.         super(text, icon, selected);
  128.         setBorderPainted(false);
  129.         setHorizontalAlignment(LEFT);
  130.     }
  131.  
  132.     /**
  133.      * Notification from the UIFactory that the L&F
  134.      * has changed. 
  135.      *
  136.      * @see JComponent#updateUI
  137.      */
  138.     public void updateUI() {
  139.         setUI((ButtonUI)UIManager.getUI(this));
  140.     }
  141.  
  142.  
  143.     /**
  144.      * Returns a string that specifies the name of the L&F class
  145.      * that renders this component.
  146.      *
  147.      * @return "CheckBoxUI"
  148.      * @see JComponent#getUIClassID
  149.      * @see UIDefaults#getUI
  150.      * @beaninfo
  151.      *        expert: true
  152.      *   description: A string that specifies the name of the L&F class
  153.      */
  154.     public String getUIClassID() {
  155.         return "CheckBoxUI";
  156.     }
  157.  
  158.  
  159.  
  160. /////////////////
  161. // Accessibility support
  162. ////////////////
  163.  
  164.     /**
  165.      * Get the AccessibleContext associated with this JComponent
  166.      *
  167.      * @return the AccessibleContext of this JComponent
  168.      * @beaninfo
  169.      *       expert: true
  170.      *  description: The AccessibleContext associated with this CheckBox.
  171.      */
  172.     public AccessibleContext getAccessibleContext() {
  173.         if (accessibleContext == null) {
  174.             accessibleContext = new AccessibleJCheckBox();
  175.         }
  176.         return accessibleContext;
  177.     }
  178.  
  179.     /**
  180.      * The class used to obtain the accessible role for this object.
  181.      * <p>
  182.      * Warning: serialized objects of this class will not be compatible with
  183.      * future swing releases.  The current serialization support is appropriate
  184.      * for short term storage or RMI between Swing1.0 applications.  It will
  185.      * not be possible to load serialized Swing1.0 objects with future releases
  186.      * of Swing.  The JDK1.2 release of Swing will be the compatibility
  187.      * baseline for the serialized form of Swing objects.
  188.      */
  189.     protected class AccessibleJCheckBox extends AccessibleJToggleButton {
  190.  
  191.         /**
  192.          * Get the role of this object.
  193.          *
  194.          * @return an instance of AccessibleRole describing the role of the object
  195.          * @see AccessibleRole
  196.          */
  197.         public AccessibleRole getAccessibleRole() {
  198.             return AccessibleRole.CHECK_BOX;
  199.         }
  200.  
  201.     } // inner class AccessibleJCheckBox
  202. }
  203.   
  204.